Add function invocation docs #12
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for invoking functions in DevRev Snap-Ins and updates the snap-in template to reference the new docs.
- Defines the
runmethod signature, context types, and return behavior infunction_invocation.mdx. - Links the function invocation guide from the
devrev-snapin-template.plain.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/function_invocation.mdx | New docs outlining the run signature, input types, and behaviors. |
| devrev-snapin-template.plain | Added a reference to the function invocation documentation. |
Comments suppressed due to low confidence (1)
docs/function_invocation.mdx:49
- TypeScript array type syntax is incorrect; use
FunctionInput[]instead of[]FunctionInput.
async function run(events: []FunctionInput): any;
patricijabrecko
force-pushed
the
function-invocation
branch
from
fc44370 to
14b1a6d
Compare
patricijabrecko
force-pushed
the
function-invocation
branch
from
14b1a6d to
4815d38
Compare
radovanjorgic
approved these changes
Jul 9, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
This pull request adds documentation and implementation details for invoking functions within DevRev Snap-Ins. The changes include updates to the
devrev-snapin-template.plainfile and the creation of a newdocs/function_invocation.mdxfile, providing developers with clear guidelines on function invocation and therunmethod's structure.Work item: https://app.devrev.ai/devrev/works/ISS-190744